core: Clean up filename utility API
authorColin Walters <walters@verbum.org>
Sun, 4 Dec 2011 17:12:34 +0000 (12:12 -0500)
committerColin Walters <walters@verbum.org>
Sun, 4 Dec 2011 17:12:34 +0000 (12:12 -0500)
Remove more unused functions, and change pathname splitting to handle
more cases like duplicate //, and to throw an error on .. as a filename.

src/libostree/ostree-repo-file.c
src/libotutil/ot-unix-utils.c
src/libotutil/ot-unix-utils.h

index 927e6ad10ba6423115e1ea21bdebbfa76b80f5a9..b08601b1f47a67725f31e7753b0f04bbf38db4be 100644 (file)
@@ -238,7 +238,7 @@ do_resolve_nonroot (OstreeRepoFile     *self,
       g_variant_get_child (container, i, "(&s&s&s)",
                            &name, &content_checksum, &metadata_checksum);
 
-      if (!ot_util_validate_file_name (name, error))
+      if (!ot_util_filename_validate (name, error))
         goto out;
           
       if (!ostree_repo_load_variant_checked (self->repo, OSTREE_SERIALIZED_TREE_VARIANT,
index 2e4eaae4255aff1b03906e761f5174e4a7ae46a8..fb6714858a6b5ff37448013b0bf75993fbddcb9e 100644 (file)
@@ -74,141 +74,86 @@ ot_util_spawn_pager (GOutputStream  **out_stream,
   return ret;
 }
 
-static int
-compare_filenames_by_component_length (const char *a,
-                                       const char *b)
-{
-  char *a_slash, *b_slash;
-
-  a_slash = strchr (a, '/');
-  b_slash = strchr (b, '/');
-  while (a_slash && b_slash)
-    {
-      a = a_slash + 1;
-      b = b_slash + 1;
-      a_slash = strchr (a, '/');
-      b_slash = strchr (b, '/');
-    }
-  if (a_slash)
-    return -1;
-  else if (b_slash)
-    return 1;
-  else
-    return 0;
-}
-
-GPtrArray *
-ot_util_sort_filenames_by_component_length (GPtrArray *files)
-{
-  GPtrArray *array = g_ptr_array_sized_new (files->len);
-  memcpy (array->pdata, files->pdata, sizeof (gpointer) * files->len);
-  g_ptr_array_sort (array, (GCompareFunc) compare_filenames_by_component_length);
-  return array;
-}
-
 gboolean
-ot_util_filename_has_dotdot (const char *path)
-{
-  char *p;
-  char last;
-
-  if (strcmp (path, "..") == 0)
-    return TRUE;
-  if (g_str_has_prefix (path, "../"))
-    return TRUE;
-  p = strstr (path, "/..");
-  if (!p)
-    return FALSE;
-  last = *(p + 1);
-  return last == '\0' || last == '/';
-}
-
-gboolean
-ot_util_validate_file_name (const char *name,
-                            GError    **error)
+ot_util_filename_validate (const char *name,
+                           GError    **error)
 {
   if (strcmp (name, ".") == 0)
     {
       g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
-                   "Invalid self-reference '.' in filename '%s'", name);
+                   "Invalid self-referential filename '.'");
       return FALSE;
     }
-  if (ot_util_filename_has_dotdot (name))
+  if (strcmp (name, "..") == 0)
     {
       g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
-                   "Invalid path uplink '..' in filename '%s'", name);
+                   "Invalid path uplink filename '..'");
       return FALSE;
     }
   if (strchr (name, '/') != NULL)
     {
       g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
-                   "Invalid / in filename '%s'", name);
+                   "Invalid / in filename %s", name);
       return FALSE;
     }
   return TRUE;
 }
 
-GPtrArray *
-ot_util_path_split (const char *path)
+static GPtrArray *
+ot_split_string_ptrarray (const char *str,
+                          char        c)
 {
-  GPtrArray *ret = NULL;
+  GPtrArray *ret = g_ptr_array_new_with_free_func (g_free);
   const char *p;
-  const char *slash;
-  int i;
 
-  g_return_val_if_fail (path[0] != '/', NULL);
-
-  ret = g_ptr_array_new ();
-  g_ptr_array_set_free_func (ret, g_free);
-
-  p = path;
   do {
-    slash = strchr (p, '/');
-    if (!slash)
+    p = strchr (str, '/');
+    if (!p)
       {
-        g_ptr_array_add (ret, g_strdup (p));
-        p = NULL;
+        g_ptr_array_add (ret, g_strdup (str));
+        str = NULL;
       }
     else
       {
-        g_ptr_array_add (ret, g_strndup (p, slash - p));
-        p = slash + 1;
+        g_ptr_array_add (ret, g_strndup (str, p - str));
+        str = p + 1;
       }
-  } while (p && *p);
-
-  /* Canonicalize by removing duplicate '.' */
-  for (i = ret->len-1; i >= 0; i--)
-    {
-      if (strcmp (ret->pdata[i], ".") == 0)
-        g_ptr_array_remove_index (ret, i);
-    }
+  } while (str && *str);
 
   return ret;
 }
 
-char *
-ot_util_path_join_n (const char *base, GPtrArray *components, int n)
+gboolean
+ot_util_path_split_validate (const char *path,
+                             GPtrArray **out_components,
+                             GError    **error)
 {
-  int max = MIN(n+1, components->len);
-  GPtrArray *subcomponents;
-  char *path;
+  gboolean ret = FALSE;
+  GPtrArray *ret_components = NULL;
   int i;
 
-  subcomponents = g_ptr_array_new ();
-
-  if (base != NULL)
-    g_ptr_array_add (subcomponents, (char*)base);
+  ret_components = ot_split_string_ptrarray (path, '/');
 
-  for (i = 0; i < max; i++)
+  /* Canonicalize by removing '.' and '', throw an error on .. */
+  for (i = ret_components->len-1; i >= 0; i--)
     {
-      g_ptr_array_add (subcomponents, components->pdata[i]);
+      const char *name = ret_components->pdata[i];
+      if (strcmp (name, "..") == 0)
+        {
+          g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
+                       "Invalid uplink '..' in path %s", path);
+          goto out;
+        }
+      if (strcmp (name, ".") == 0 || name[0] == '\0')
+        g_ptr_array_remove_index (ret_components, i);
     }
-  g_ptr_array_add (subcomponents, NULL);
-  
-  path = g_build_filenamev ((char**)subcomponents->pdata);
-  g_ptr_array_free (subcomponents, TRUE);
-  
-  return path;
+
+  ret = TRUE;
+  ot_transfer_out_value(out_components, ret_components);
+ out:
+  if (ret_components)
+    g_ptr_array_unref (ret_components);
+  return ret;
 }
 
 void
index ad388ad70d1172bc294f4d75e75c9b9519526366..58dd59b5a0a103a17c70e71f68ae6659e602ed85 100644 (file)
@@ -43,16 +43,9 @@ void ot_util_fatal_literal (const char *msg) G_GNUC_NORETURN;
 
 void ot_util_fatal_gerror (GError *error) G_GNUC_NORETURN;
 
-gboolean ot_util_filename_has_dotdot (const char *path);
+gboolean ot_util_filename_validate (const char *name, GError **error);
 
-gboolean ot_util_validate_file_name (const char *name,
-                                     GError    **error);
-
-GPtrArray *ot_util_sort_filenames_by_component_length (GPtrArray *files);
-
-GPtrArray* ot_util_path_split (const char *path);
-
-char *ot_util_path_join_n (const char *base, GPtrArray *components, int n);
+gboolean ot_util_path_split_validate (const char *path, GPtrArray **out_components, GError **error);
 
 void ot_util_set_error_from_errno (GError **error, gint saved_errno);